FHIR © HL7.org  |  Server Home  |  FHIR Server FHIR Server 3.7.16  |  FHIR Version n/a  User: [n/a]

Resource CapabilityStatement/FHIR Server from package hl7.fhir.us.Davinci-drug-formulary#1.0.0 (47 ms)

Package hl7.fhir.us.Davinci-drug-formulary
Type CapabilityStatement
Id Id
FHIR Version R4
Source http://hl7.org/fhir/us/davinci-drug-formulary/http://hl7.org/fhir/us/davinci-drug-formulary/STU1/CapabilityStatement-usdf-server.html
Url http://hl7.org/fhir/us/Davinci-drug-formulary/CapabilityStatement/usdf-server
Version 1.0.0
Status active
Date 2020-01-08T00:00:00+10:00
Name USDFServerCapabilityStatement
Title US Drug Formulary Server Capability Statement
Experimental False
Realm us
Authority hl7
Description This Section describes the expected capabilities of the US Drug Formulary Server actor which is responsible for providing responses to the queries submitted by the US Drug Formulary Requestors. The complete list of FHIR profiles, RESTful operations, and search parameters supported by US Drug Formulary Server are defined.
Kind requirements

Resources that use this resource

No resources found


Resources that this resource uses

ImplementationGuide
http://hl7.org/fhir/us/Davinci-drug-formulary/ImplementationGuide/hl7.fhir.us.Davinci-drug-formulary DaVinci Payer Data Exchange (PDex) US Drug Formulary
http://hl7.org/fhir/us/Davinci-drug-formulary/SearchParameter/DrugName DrugName
http://hl7.org/fhir/us/Davinci-drug-formulary/SearchParameter/DrugPlan DrugPlan
http://hl7.org/fhir/us/Davinci-drug-formulary/SearchParameter/DrugTier DrugTier
http://hl7.org/fhir/us/Davinci-drug-formulary/StructureDefinition/usdf-CoveragePlan Coverage Plan
http://hl7.org/fhir/us/Davinci-drug-formulary/StructureDefinition/usdf-FormularyDrug Formulary Drug


Narrative

Note: links and images are rebased to the (stated) source

USDFServerCapabilityStatement

This Section describes the expected capabilities of the US Drug Formulary Server actor which is responsible for providing responses to the queries submitted by the US Drug Formulary Requestors. The complete list of FHIR profiles, RESTful operations, and search parameters supported by US Drug Formulary Server are defined.

Mode: SERVER
Description: The US Drug Formulary Server **SHALL**:
  1. Support the US Drug Formulary CoveragePlan (List) and FormularyDrug (MedicationKnowledge) resource profile.
  2. Implement the RESTful behavior according to the FHIR specification.
  3. Return the following response classes:
    • (Status 400): invalid parameter
    • (Status 401/4xx): unauthorized request
    • (Status 403): insufficient scope
    • Status 404): unknown resource
    • (Status 410): deleted resource
  4. Support json source formats for all US Drug Formulary interactions.
The US Drug Formulary Server **SHOULD**:
  1. Support xml source formats for all US Drug Formulary interactions.
The US Drug Formulary Server supports the following transactions:
  • CoveragePlan (List) Resource
    • **SHALL**: search-type, read,
    • **SHOULD** : vread, history-instance
    • **MAY** : create, update, patch, delete, history-type
  • FormularyDrug (MedicationKnowledge) Resource
    • **SHALL**: search-type, read,
    • **SHOULD** : vread, history-instance
    • **MAY** : create, update, patch, delete, history-type
The US Drug Formulary Server **SHALL** support the following searchParameters individually and in combination:
  • FormularyDrug (MedicationKnowledge) Resource
    • DrugName
    • DrugPlan
    • DrugTier
    • code

Source

{
  "resourceType" : "CapabilityStatement",
  "id" : "usdf-server",
  "text" : {
    "status" : "additional",
    "div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\"><h2 id=\"title\">USDFServerCapabilityStatement</h2> <p>This Section describes the expected capabilities of the US Drug Formulary Server actor which is responsible for providing responses to the queries submitted by the US Drug Formulary Requestors. The complete list of FHIR profiles, RESTful operations, and search parameters supported by US Drug Formulary Server are defined. </p> <table> <tr> <td>Mode:</td> <td>SERVER</td> </tr> <tr> <td>Description:</td> <td>The US Drug Formulary Server **SHALL**: <ol> <li>Support the US Drug Formulary CoveragePlan (List) and FormularyDrug (MedicationKnowledge) resource profile.</li> <li>Implement the RESTful behavior according to the FHIR specification.</li> <li>Return the following response classes: <ul> <li>(Status 400): invalid parameter</li> <li>(Status 401/4xx): unauthorized request</li> <li>(Status 403): insufficient scope</li> <li>Status 404): unknown resource</li> <li>(Status 410): deleted resource</li> </ul> </li> <li>Support json source formats for all US Drug Formulary interactions.</li> </ol> </td> </tr> <tr> <td> </td> <td> The US Drug Formulary Server **SHOULD**: <ol> <li>Support xml source formats for all US Drug Formulary interactions.</li> </ol> </td></tr> <tr> <td> </td> <td>The US Drug Formulary Server supports the following transactions: <ul> <li>CoveragePlan (List) Resource <ul> <li>**SHALL**: search-type, read, </li> <li>**SHOULD** : vread, history-instance</li> <li>**MAY** : create, update, patch, delete, history-type</li> </ul> </li> <li>FormularyDrug (MedicationKnowledge) Resource <ul> <li>**SHALL**: search-type, read, </li> <li>**SHOULD** : vread, history-instance</li> <li>**MAY** : create, update, patch, delete, history-type</li> </ul> </li> </ul> </td> </tr> <tr> <td> </td> <td>The US Drug Formulary Server **SHALL** support the following searchParameters individually and in combination: <ul> <li>FormularyDrug (MedicationKnowledge) Resource <ul> <li>DrugName </li> <li>DrugPlan </li> <li>DrugTier </li> <li>code</li> </ul> </li> </ul> </td> </tr> </table> </div>"
  },
  "url" : "http://hl7.org/fhir/us/Davinci-drug-formulary/CapabilityStatement/usdf-server",
  "version" : "1.0.0",
  "name" : "USDFServerCapabilityStatement",
  "title" : "US Drug Formulary Server Capability Statement",
  "status" : "active",
  "experimental" : false,
  "date" : "2020-01-08T00:00:00+10:00",
  "publisher" : "HL7 International - US Realm Steering Committee",
  "contact" : [
    {
      "telecom" : [
        {
          "system" : "url",
          "value" : "http://www.hl7.org/Special/committees/usrealm/index.cfm"
        }
      ]
    }
  ],
  "description" : "This Section describes the expected capabilities of the US Drug Formulary Server actor which is responsible for providing responses to the queries submitted by the US Drug Formulary Requestors. The complete list of FHIR profiles, RESTful operations, and search parameters supported by US Drug Formulary Server are defined. ",
  "jurisdiction" : [
    {
      "coding" : [
        {
          "system" : "urn:iso:std:iso:3166",
          "code" : "US",
          "display" : "United States of America"
        }
      ]
    }
  ],
  "kind" : "requirements",
  "fhirVersion" : "4.0.1",
  "format" : [
    "xml",
    "json"
  ],
  "patchFormat" : [
    "application/json-patch+json"
  ],
  "implementationGuide" : [
    "http://hl7.org/fhir/us/Davinci-drug-formulary/ImplementationGuide/hl7.fhir.us.Davinci-drug-formulary"
  ],
  "rest" : [
    {
      "mode" : "server",
      "documentation" : "The US Drug Formulary Server **SHALL**:\n\n1. Support the US Drug Formulary CoveragePlan (List) and FormularyDrug (MedicationKnowledge) resource profile.\n1. Implement the RESTful behavior according to the FHIR specification.\n1. Return the following response classes:\n - (Status 400): invalid parameter\n - (Status 401/4xx): unauthorized request\n - (Status 403): insufficient scope\n - (Status 404): unknown resource\n - (Status 410): deleted resource.\n1. Support json source formats for all US Drug Formulary interactions.\n\nThe US Drug Formulary Server **SHOULD**:\n\n1. Support xml source formats for all US Drug Formulary interactions.",
      "security" : {
        "description" : "1. See the [General Security Considerations](security.html) section for requirements and recommendations.\n1. A server **SHALL** reject any unauthorized requests by returning an `HTTP 401` unauthorized response code."
      },
      "resource" : [
        {
          "extension" : [
            {
              "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
              "valueCode" : "SHALL"
            }
          ],
          "type" : "List",
          "supportedProfile" : [
            "http://hl7.org/fhir/us/Davinci-drug-formulary/StructureDefinition/usdf-CoveragePlan"
          ],
          "interaction" : [
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode" : "MAY"
                }
              ],
              "code" : "create"
            },
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode" : "SHALL"
                }
              ],
              "code" : "search-type"
            },
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode" : "SHALL"
                }
              ],
              "code" : "read"
            },
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode" : "SHOULD"
                }
              ],
              "code" : "vread"
            },
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode" : "MAY"
                }
              ],
              "code" : "update"
            },
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode" : "MAY"
                }
              ],
              "code" : "patch"
            },
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode" : "MAY"
                }
              ],
              "code" : "delete"
            },
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode" : "SHOULD"
                }
              ],
              "code" : "history-instance"
            },
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode" : "MAY"
                }
              ],
              "code" : "history-type"
            }
          ],
          "referencePolicy" : [
            "resolves"
          ],
          "searchRevInclude" : [
            "MedicationKnowledge:_id"
          ]
        },
        {
          "extension" : [
            {
              "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
              "valueCode" : "SHALL"
            },
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode" : "SHALL"
                },
                {
                  "url" : "required",
                  "valueString" : "DrugName"
                },
                {
                  "url" : "required",
                  "valueString" : "DrugPlan"
                },
                {
                  "url" : "required",
                  "valueString" : "DrugTier"
                },
                {
                  "url" : "required",
                  "valueString" : "code"
                }
              ],
              "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination"
            }
          ],
          "type" : "MedicationKnowledge",
          "supportedProfile" : [
            "http://hl7.org/fhir/us/Davinci-drug-formulary/StructureDefinition/usdf-FormularyDrug"
          ],
          "interaction" : [
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode" : "MAY"
                }
              ],
              "code" : "create"
            },
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode" : "SHALL"
                }
              ],
              "code" : "search-type"
            },
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode" : "SHALL"
                }
              ],
              "code" : "read"
            },
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode" : "SHOULD"
                }
              ],
              "code" : "vread"
            },
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode" : "MAY"
                }
              ],
              "code" : "update"
            },
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode" : "MAY"
                }
              ],
              "code" : "patch"
            },
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode" : "MAY"
                }
              ],
              "code" : "delete"
            },
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode" : "SHOULD"
                }
              ],
              "code" : "history-instance"
            },
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode" : "MAY"
                }
              ],
              "code" : "history-type"
            }
          ],
          "referencePolicy" : [
            "resolves"
          ],
          "searchRevInclude" : [
            "List:entry"
          ],
          "searchParam" : [
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode" : "SHALL"
                }
              ],
              "name" : "DrugName",
              "definition" : "http://hl7.org/fhir/us/Davinci-drug-formulary/SearchParameter/DrugName",
              "type" : "string"
            },
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode" : "SHALL"
                }
              ],
              "name" : "DrugPlan",
              "definition" : "http://hl7.org/fhir/us/Davinci-drug-formulary/SearchParameter/DrugPlan",
              "type" : "string"
            },
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode" : "SHALL"
                }
              ],
              "name" : "DrugTier",
              "definition" : "http://hl7.org/fhir/us/Davinci-drug-formulary/SearchParameter/DrugTier",
              "type" : "token"
            }
          ]
        }
      ]
    }
  ]
}

XIG built as of ??metadata-date??. Found ??metadata-resources?? resources in ??metadata-packages?? packages.